Grouping Annotations

To enable end-users to group annotation elements, the application must set the AllowUserGrouping property to True. The AllowUserGrouping property sets or returns whether end users can create and destroy groups.

The default value of this property is False.

End-user grouping actions are monitored by the application using events as follows:

Create a Group

The end-user selects multiple annotations by clicking within the bounding rectangle of the annotation and holding down the shift key. The user then presses Ctrl-G to create a new group which includes each of the selected annotations. The new groups's yoked property is automatically set to true, allowing immediate user manipulation of the group. The UserGroupCreated event is raised to notify the application that a new group has been created.

Select a Group

The end-user selects a group by clicking within the bounding rectangle of a deselected group. An AnnotateEvent event is raised with a type of NX_GroupSelected and a Data parameter containing the groupID of the selected group.

Deselect a Group

The end-user de-selects a group by clicking again outside the bounding rectangle of the selected group. An AnnotateEvent event raises with a type of NX_GroupSelected and a Data parameter containing a value of zero, meaning that a selected group is now unselected.

Destroy a Group

The end-user selects one or more groups to destroy. The end-user then presses Ctrl-U to destroy the selected group. The UserGroupDestroyed event is raised to notify the application that a group has been destroyed.